Skip to content

[docs] Updated outdated commit message guidelines#258

Merged
nemesifier merged 1 commit intomasterfrom
update-contributing-guidelines
Jan 30, 2026
Merged

[docs] Updated outdated commit message guidelines#258
nemesifier merged 1 commit intomasterfrom
update-contributing-guidelines

Conversation

@nemesifier
Copy link
Member

@nemesifier nemesifier commented Jan 30, 2026

The commit message guidelines were outdated.

@nemesifier nemesifier self-assigned this Jan 30, 2026
@coderabbitai
Copy link

coderabbitai bot commented Jan 30, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

Updates to the contributing guidelines in developer/contributing.rst. The commit message tag scope was broadened from a module/file-specific pattern to general categories (feature/change/fix/chores). The example commit URL was changed to reference the openwisp-controller module. The sample subject line and issue reference were updated, and a multi-line explanatory note was replaced with a concise description about when Config object status is updated.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title clearly describes the main change: updating outdated commit message guidelines in documentation.
Description check ✅ Passed The description is directly related to the changeset, explaining that the commit message guidelines were outdated, which aligns with the documentation updates made.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-contributing-guidelines
📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e4483b3 and 1696a03.

📒 Files selected for processing (1)
  • developer/contributing.rst
🚧 Files skipped from review as they are similar to previous changes (1)
  • developer/contributing.rst
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]
coderabbitai bot requested changes Jan 30, 2026
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents 
In `@developer/contributing.rst`:
- Around line 121-137: The commit-message template shows "Fixes #<issue-number>"
but the example uses "Closes `#213`"; update the template text around the
commit-footer so they match or explicitly state both are acceptable. Edit the
block that contains "[feature/change/fix/chores] Short description
#<issue-number>" and the trailing "Fixes #<issue-number>" to either use "Closes
#<issue-number>" to match the example ("Closes `#213`") or add a brief note saying
both "Fixes" and "Closes" are acceptable and equivalent for issue closing.
📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 256bae9 and e4483b3.

📒 Files selected for processing (1)
  • developer/contributing.rst
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

@github-project-automation github-project-automation bot moved this from To do (general) to In progress in OpenWISP Contributor's Board Jan 30, 2026
@nemesifier nemesifier force-pushed the update-contributing-guidelines branch from e4483b3 to 1696a03 Compare January 30, 2026 16:46
@nemesifier nemesifier merged commit 1696a03 into master Jan 30, 2026
1 of 2 checks passed
@nemesifier nemesifier deleted the update-contributing-guidelines branch January 30, 2026 16:54
@github-project-automation github-project-automation bot moved this from In progress to Done in OpenWISP Contributor's Board Jan 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

@nemesifier nemesifier

Labels

Docs

Projects

OpenWISP Contributor's Board
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@nemesifier